<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.14"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>v_hdmitxss: audio_prbs_genchk_drv.c File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.gif"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">v_hdmitxss
   </div>
   <div id="projectbrief">Xilinx SDK Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.14 -->
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',false,false,'search.php','Search');
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('audio__prbs__genchk__drv_8c.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">audio_prbs_genchk_drv.c File Reference</div>  </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Overview</h2>
<div class="textblock"><p>This file contains the driver implementation for the Audio PRBS generator and checker used in the HDMI example design. </p>
<pre>
MODIFICATION HISTORY:</pre><pre>Ver   Who  Date        Changes
<hr/>

X.XX  XX  YYYY/MM/DD   ...
1.00  RHe 2015/05/20   First release
</pre> </div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a9f9101fb852938b4d64fce732ee97911"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio__prbs__genchk__drv_8c.html#a9f9101fb852938b4d64fce732ee97911">XAudioPRBSGenChk_Init</a> (XAudioPRBSGenChk_t *InstancePtr, u32 PRBSGenChkBase)</td></tr>
<tr class="memdesc:a9f9101fb852938b4d64fce732ee97911"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function initializes the Audio PRBS Generator/Checker.  <a href="#a9f9101fb852938b4d64fce732ee97911">More...</a><br /></td></tr>
<tr class="separator:a9f9101fb852938b4d64fce732ee97911"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa538f94196a82a47d1311ce8ad2ab096"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio__prbs__genchk__drv_8c.html#aa538f94196a82a47d1311ce8ad2ab096">XAudioPRBSGenChk_Enable</a> (XAudioPRBSGenChk_t *InstancePtr, u8 setclr)</td></tr>
<tr class="memdesc:aa538f94196a82a47d1311ce8ad2ab096"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function enables the Generator/Checker.  <a href="#aa538f94196a82a47d1311ce8ad2ab096">More...</a><br /></td></tr>
<tr class="separator:aa538f94196a82a47d1311ce8ad2ab096"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a309924a81559d9ac866cfc858a4f128e"><td class="memItemLeft" align="right" valign="top">u8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio__prbs__genchk__drv_8c.html#a309924a81559d9ac866cfc858a4f128e">XAudioPRBSGenChk_IsEnabled</a> (XAudioPRBSGenChk_t *InstancePtr)</td></tr>
<tr class="memdesc:a309924a81559d9ac866cfc858a4f128e"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the status of the Checker.  <a href="#a309924a81559d9ac866cfc858a4f128e">More...</a><br /></td></tr>
<tr class="separator:a309924a81559d9ac866cfc858a4f128e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53df4c12e8c1f9e073c553c3c26e4d2f"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio__prbs__genchk__drv_8c.html#a53df4c12e8c1f9e073c553c3c26e4d2f">XAudioPRBSGenChk_SetAxiClkFrq</a> (XAudioPRBSGenChk_t *InstancePtr, u32 ClkFrq)</td></tr>
<tr class="memdesc:a53df4c12e8c1f9e073c553c3c26e4d2f"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the AXI clock frequency configuration.  <a href="#a53df4c12e8c1f9e073c553c3c26e4d2f">More...</a><br /></td></tr>
<tr class="separator:a53df4c12e8c1f9e073c553c3c26e4d2f"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adc6812c6007953d2add855bf2ed2fbca"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio__prbs__genchk__drv_8c.html#adc6812c6007953d2add855bf2ed2fbca">XAudioPRBSGenChk_SetAudCfg</a> (XAudioPRBSGenChk_t *InstancePtr, AudioRate_t SampleRate)</td></tr>
<tr class="memdesc:adc6812c6007953d2add855bf2ed2fbca"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the audio configuration for the Generator/Checker.  <a href="#adc6812c6007953d2add855bf2ed2fbca">More...</a><br /></td></tr>
<tr class="separator:adc6812c6007953d2add855bf2ed2fbca"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acefd6ea4f1073fad50cb692830a8b0dd"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio__prbs__genchk__drv_8c.html#acefd6ea4f1073fad50cb692830a8b0dd">XAudioPRBSGenChk_SetChCfg</a> (XAudioPRBSGenChk_t *InstancePtr, u8 ChannelCount)</td></tr>
<tr class="memdesc:acefd6ea4f1073fad50cb692830a8b0dd"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the audio channel configuration for the Generator/Checker.  <a href="#acefd6ea4f1073fad50cb692830a8b0dd">More...</a><br /></td></tr>
<tr class="separator:acefd6ea4f1073fad50cb692830a8b0dd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae7f605dd588f647cedeee83c37cdf627"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio__prbs__genchk__drv_8c.html#ae7f605dd588f647cedeee83c37cdf627">XAudioPRBSGenChk_SetSmpCntThres</a> (XAudioPRBSGenChk_t *InstancePtr, u8 Threshold)</td></tr>
<tr class="memdesc:ae7f605dd588f647cedeee83c37cdf627"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sets the threshold value for the sample count checker.  <a href="#ae7f605dd588f647cedeee83c37cdf627">More...</a><br /></td></tr>
<tr class="separator:ae7f605dd588f647cedeee83c37cdf627"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aa3103d2fc74e4dcdb0c0c2c43e22e31c"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio__prbs__genchk__drv_8c.html#aa3103d2fc74e4dcdb0c0c2c43e22e31c">XAudioPRBSGenChk_GetDataErrCnt</a> (XAudioPRBSGenChk_t *InstancePtr)</td></tr>
<tr class="memdesc:aa3103d2fc74e4dcdb0c0c2c43e22e31c"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the data error count from the checker.  <a href="#aa3103d2fc74e4dcdb0c0c2c43e22e31c">More...</a><br /></td></tr>
<tr class="separator:aa3103d2fc74e4dcdb0c0c2c43e22e31c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a907b548546ed5e1620f4c3336fa95804"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio__prbs__genchk__drv_8c.html#a907b548546ed5e1620f4c3336fa95804">XAudioPRBSGenChk_GetSmpCntErrCnt</a> (XAudioPRBSGenChk_t *InstancePtr)</td></tr>
<tr class="memdesc:a907b548546ed5e1620f4c3336fa95804"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the sample count error count from the checker.  <a href="#a907b548546ed5e1620f4c3336fa95804">More...</a><br /></td></tr>
<tr class="separator:a907b548546ed5e1620f4c3336fa95804"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8eb33be65ba16c365c22f8f4cbeaeda3"><td class="memItemLeft" align="right" valign="top">u32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio__prbs__genchk__drv_8c.html#a8eb33be65ba16c365c22f8f4cbeaeda3">XAudioPRBSGenChk_GetSmpCntCapt</a> (XAudioPRBSGenChk_t *InstancePtr, u8 ChannelID)</td></tr>
<tr class="memdesc:a8eb33be65ba16c365c22f8f4cbeaeda3"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function returns the captured sample count for the last sample count error from the checker.  <a href="#a8eb33be65ba16c365c22f8f4cbeaeda3">More...</a><br /></td></tr>
<tr class="separator:a8eb33be65ba16c365c22f8f4cbeaeda3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70b5ef5c0ed355e250a4c81629babe87"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="audio__prbs__genchk__drv_8c.html#a70b5ef5c0ed355e250a4c81629babe87">XAudioPRBSGenChk_ClrErrCnt</a> (XAudioPRBSGenChk_t *InstancePtr)</td></tr>
<tr class="memdesc:a70b5ef5c0ed355e250a4c81629babe87"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function clears the error counts for the checker.  <a href="#a70b5ef5c0ed355e250a4c81629babe87">More...</a><br /></td></tr>
<tr class="separator:a70b5ef5c0ed355e250a4c81629babe87"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="a70b5ef5c0ed355e250a4c81629babe87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70b5ef5c0ed355e250a4c81629babe87">&#9670;&nbsp;</a></span>XAudioPRBSGenChk_ClrErrCnt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XAudioPRBSGenChk_ClrErrCnt </td>
          <td>(</td>
          <td class="paramtype">XAudioPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function clears the error counts for the checker. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XAudioPRBSGenChk_t core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if action was successful</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd></dd></dl>

<p class="reference">References <a class="el" href="audio__prbs__genchk__drv_8h.html#a05b5320ce66bf42ef7a0ef060e522c1c">XAudio_PRBS_GenChk_WriteReg</a>.</p>

</div>
</div>
<a id="aa538f94196a82a47d1311ce8ad2ab096"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa538f94196a82a47d1311ce8ad2ab096">&#9670;&nbsp;</a></span>XAudioPRBSGenChk_Enable()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XAudioPRBSGenChk_Enable </td>
          <td>(</td>
          <td class="paramtype">XAudioPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>setclr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function enables the Generator/Checker. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XAudioPRBSGenChk_t core instance. </td></tr>
    <tr><td class="paramname">setclr</td><td>specifies TRUE/FALSE value to either assert or release Generator/Checker reset.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if action was successful</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="audio__prbs__genchk__drv_8h.html#aafe974eaf7a0b75fe6b5d8fed9449b87">XAudio_PRBS_GenChk_ReadReg</a>.</p>

</div>
</div>
<a id="aa3103d2fc74e4dcdb0c0c2c43e22e31c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa3103d2fc74e4dcdb0c0c2c43e22e31c">&#9670;&nbsp;</a></span>XAudioPRBSGenChk_GetDataErrCnt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XAudioPRBSGenChk_GetDataErrCnt </td>
          <td>(</td>
          <td class="paramtype">XAudioPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns the data error count from the checker. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XAudioPRBSGenChk_t core instance..</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of data errors found</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The count value does not wrap after reaching 0xFFFFFFFF. </dd></dl>

<p class="reference">References <a class="el" href="audio__prbs__genchk__drv_8h.html#aafe974eaf7a0b75fe6b5d8fed9449b87">XAudio_PRBS_GenChk_ReadReg</a>.</p>

</div>
</div>
<a id="a8eb33be65ba16c365c22f8f4cbeaeda3"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8eb33be65ba16c365c22f8f4cbeaeda3">&#9670;&nbsp;</a></span>XAudioPRBSGenChk_GetSmpCntCapt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XAudioPRBSGenChk_GetSmpCntCapt </td>
          <td>(</td>
          <td class="paramtype">XAudioPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>ChannelID</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns the captured sample count for the last sample count error from the checker. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XAudioPRBSGenChk_t core instance.. </td></tr>
    <tr><td class="paramname">ChannelID</td><td>specifies the audio channel</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The captured sample counter value for the specified channel</dd></dl>
<dl class="section note"><dt>Note</dt><dd>Sample count capture values are initialized to 0xFFFFFFFF during reset. </dd></dl>

</div>
</div>
<a id="a907b548546ed5e1620f4c3336fa95804"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a907b548546ed5e1620f4c3336fa95804">&#9670;&nbsp;</a></span>XAudioPRBSGenChk_GetSmpCntErrCnt()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u32 XAudioPRBSGenChk_GetSmpCntErrCnt </td>
          <td>(</td>
          <td class="paramtype">XAudioPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns the sample count error count from the checker. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XAudioPRBSGenChk_t core instance..</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of sample count errors found</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The count value does not wrap after reaching 0xFFFFFFFF. </dd></dl>

<p class="reference">References <a class="el" href="audio__prbs__genchk__drv_8h.html#aafe974eaf7a0b75fe6b5d8fed9449b87">XAudio_PRBS_GenChk_ReadReg</a>.</p>

</div>
</div>
<a id="a9f9101fb852938b4d64fce732ee97911"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9f9101fb852938b4d64fce732ee97911">&#9670;&nbsp;</a></span>XAudioPRBSGenChk_Init()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XAudioPRBSGenChk_Init </td>
          <td>(</td>
          <td class="paramtype">XAudioPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>PRBSGenChkBase</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function initializes the Audio PRBS Generator/Checker. </p>
<p>This function must be called prior to using the Generator/Checker.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XAudioPRBSGenChk_t core instance. </td></tr>
    <tr><td class="paramname">PRBSGenChkBase</td><td>is the base address for the core.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if initialization was successful.</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="audio__prbs__genchk__drv_8c.html#a53df4c12e8c1f9e073c553c3c26e4d2f">XAudioPRBSGenChk_SetAxiClkFrq()</a>, and <a class="el" href="audio__prbs__genchk__drv_8c.html#ae7f605dd588f647cedeee83c37cdf627">XAudioPRBSGenChk_SetSmpCntThres()</a>.</p>

</div>
</div>
<a id="a309924a81559d9ac866cfc858a4f128e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a309924a81559d9ac866cfc858a4f128e">&#9670;&nbsp;</a></span>XAudioPRBSGenChk_IsEnabled()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">u8 XAudioPRBSGenChk_IsEnabled </td>
          <td>(</td>
          <td class="paramtype">XAudioPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function returns the status of the Checker. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XAudioPRBSGenChk_t core instance.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>TRUE if checker is enabled</li>
<li>FALSE if checker is disabled</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The checker is enabled after the enable bit is set and after a start of audio block has been seen. </dd></dl>

<p class="reference">References <a class="el" href="audio__prbs__genchk__drv_8h.html#aafe974eaf7a0b75fe6b5d8fed9449b87">XAudio_PRBS_GenChk_ReadReg</a>.</p>

</div>
</div>
<a id="adc6812c6007953d2add855bf2ed2fbca"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adc6812c6007953d2add855bf2ed2fbca">&#9670;&nbsp;</a></span>XAudioPRBSGenChk_SetAudCfg()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XAudioPRBSGenChk_SetAudCfg </td>
          <td>(</td>
          <td class="paramtype">XAudioPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">AudioRate_t&#160;</td>
          <td class="paramname"><em>SampleRate</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the audio configuration for the Generator/Checker. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XAudioPRBSGenChk_t core instance. </td></tr>
    <tr><td class="paramname">SampleRate</td><td>specifies the audio sample rate.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if action was successful</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="audio__prbs__genchk__drv_8h.html#aafe974eaf7a0b75fe6b5d8fed9449b87">XAudio_PRBS_GenChk_ReadReg</a>.</p>

</div>
</div>
<a id="a53df4c12e8c1f9e073c553c3c26e4d2f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a53df4c12e8c1f9e073c553c3c26e4d2f">&#9670;&nbsp;</a></span>XAudioPRBSGenChk_SetAxiClkFrq()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XAudioPRBSGenChk_SetAxiClkFrq </td>
          <td>(</td>
          <td class="paramtype">XAudioPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u32&#160;</td>
          <td class="paramname"><em>ClkFrq</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the AXI clock frequency configuration. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XAudioPRBSGenChk_t core instance. </td></tr>
    <tr><td class="paramname">ClkFrq</td><td>specifies the used clock frequency in Hz</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if action was successful</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="audio__prbs__genchk__drv_8h.html#a05b5320ce66bf42ef7a0ef060e522c1c">XAudio_PRBS_GenChk_WriteReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="audio__prbs__genchk__drv_8h.html#a9f9101fb852938b4d64fce732ee97911">XAudioPRBSGenChk_Init()</a>.</p>

</div>
</div>
<a id="acefd6ea4f1073fad50cb692830a8b0dd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acefd6ea4f1073fad50cb692830a8b0dd">&#9670;&nbsp;</a></span>XAudioPRBSGenChk_SetChCfg()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XAudioPRBSGenChk_SetChCfg </td>
          <td>(</td>
          <td class="paramtype">XAudioPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>ChannelCount</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the audio channel configuration for the Generator/Checker. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XAudioPRBSGenChk_t core instance. </td></tr>
    <tr><td class="paramname">ChannelCount</td><td>specifies the audio channel count.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if action was successful</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="audio__prbs__genchk__drv_8h.html#aafe974eaf7a0b75fe6b5d8fed9449b87">XAudio_PRBS_GenChk_ReadReg</a>.</p>

</div>
</div>
<a id="ae7f605dd588f647cedeee83c37cdf627"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae7f605dd588f647cedeee83c37cdf627">&#9670;&nbsp;</a></span>XAudioPRBSGenChk_SetSmpCntThres()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int XAudioPRBSGenChk_SetSmpCntThres </td>
          <td>(</td>
          <td class="paramtype">XAudioPRBSGenChk_t *&#160;</td>
          <td class="paramname"><em>InstancePtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">u8&#160;</td>
          <td class="paramname"><em>Threshold</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sets the threshold value for the sample count checker. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">InstancePtr</td><td>is a pointer to the XAudioPRBSGenChk_t core instance. </td></tr>
    <tr><td class="paramname">Threshold</td><td>specifies the number of audio samples the sample count can deviate from the expected before generating a sample count error.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS if action was successful</li>
</ul>
</dd></dl>
<dl class="section note"><dt>Note</dt><dd>None. </dd></dl>

<p class="reference">References <a class="el" href="audio__prbs__genchk__drv_8h.html#aafe974eaf7a0b75fe6b5d8fed9449b87">XAudio_PRBS_GenChk_ReadReg</a>.</p>

<p class="reference">Referenced by <a class="el" href="audio__prbs__genchk__drv_8h.html#a9f9101fb852938b4d64fce732ee97911">XAudioPRBSGenChk_Init()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Copyright &copy; 2015 Xilinx Inc. All rights reserved.</li>
  </ul>
</div>
</body>
</html>
